fix: Policy/policy.open-cluster-management.io stuck in progressing status when no clusters match the policy (#21296) #21297
+130
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…atus when no clusters match the policy (argoproj#21296) When a policy does not apply to a cluster because the placementrule matches no cluster at all then the status will look like the following: status: placement: - placementBinding: group-one-placement-binding placementRule: group-one-placement Without this change the above will show up as progressing even though there is really nothing to progress. Let's take care of this case by returning healthy when there is no compliant field but the array under placement is non-zero, which means that its placement resolution has happened and there is nothing to do. Fixes: argoproj#21296 Signed-off-by: Michele Baldessari <[email protected]>
🔴 Preview Environment stopped on BunnyshellSee: Environment Details | Pipeline Logs Available commands (reply to this comment):
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #21297 +/- ##
==========================================
- Coverage 55.23% 53.29% -1.94%
==========================================
Files 337 337
Lines 57055 57055
==========================================
- Hits 31515 30409 -1106
- Misses 22847 24001 +1154
+ Partials 2693 2645 -48 ☔ View full report in Codecov by Sentry. |
andrii-korotkov-verkada
approved these changes
Dec 29, 2024
dhaiducek
suggested changes
Jan 2, 2025
| -- it is not being applied to any clusters | ||
| if obj.status.compliant == nil and #obj.status.placement > 0 then | ||
| hs.status = "Healthy" | ||
| hs.message = "No clusters are matching this policy" |
There was a problem hiding this comment.
nit: wording
Suggested change
| hs.message = "No clusters are matching this policy" | |
| hs.message = "No clusters match this policy" |
Comment on lines
+8
to
+10
| -- A policy will not have a compliant field but will have a placement key set if | ||
| -- it is not being applied to any clusters | ||
| if obj.status.compliant == nil and #obj.status.placement > 0 then |
There was a problem hiding this comment.
An additional conditional is required for the case where clusters were matched but are not yet reporting status.
Suggested change
| -- A policy will not have a compliant field but will have a placement key set if | |
| -- it is not being applied to any clusters | |
| if obj.status.compliant == nil and #obj.status.placement > 0 then | |
| -- A policy will not have a compliant field but will have a placement key set if | |
| -- it is not being applied to any clusters | |
| if obj.status.compliant == nil and #obj.status.placement > 0 and obj.status.status == nil then |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a policy does not apply to a cluster because the placementrule matches no cluster at all then the status will look like the following:
Without this change the above will show up as progressing even though there is really nothing to progress.
Let's take care of this case by returning healthy when there is no compliant field but the array under placement is non-zero, which means that its placement resolution has happened and there is nothing to do.
Fixes: #21296
Ideally this should be backported to release-2.13 (only)
Checklist: